From d882420be63f1979ff89a8e99be0f0791a45a0ff Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 5 Nov 2004 06:07:44 +0000 Subject: [PATCH] Markup fixes. 2004-11-04 Matthias Clasen * gtk/tmpl/gtkaboutdialog.sgml: * gtk/migrating-GtkColorButton.sgml: * gtk/migrating-GtkIconView.sgml: * gtk/migrating-GtkAboutDialog.sgml: Markup fixes. --- docs/reference/ChangeLog | 7 ++ .../gtk/migrating-GtkAboutDialog.sgml | 36 +++++---- .../gtk/migrating-GtkColorButton.sgml | 30 +++++--- docs/reference/gtk/migrating-GtkIconView.sgml | 73 ++++++++++++------- docs/reference/gtk/tmpl/gtkaboutdialog.sgml | 2 +- 5 files changed, 91 insertions(+), 57 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 0f6021ac63..9c573ffea6 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2004-11-04 Matthias Clasen + + * gtk/tmpl/gtkaboutdialog.sgml: + * gtk/migrating-GtkColorButton.sgml: + * gtk/migrating-GtkIconView.sgml: + * gtk/migrating-GtkAboutDialog.sgml: Markup fixes. + 2004-11-04 Matthias Clasen * gtk/gtk-docs.sgml: diff --git a/docs/reference/gtk/migrating-GtkAboutDialog.sgml b/docs/reference/gtk/migrating-GtkAboutDialog.sgml index 99dd2578e8..129b844fc0 100644 --- a/docs/reference/gtk/migrating-GtkAboutDialog.sgml +++ b/docs/reference/gtk/migrating-GtkAboutDialog.sgml @@ -3,21 +3,23 @@ Migrating from GnomeAbout to GtkAboutDialog - Since version 2.6, GTK+ provides the GtkAboutDialog - widget as a replacement for the GnomeAbout dialog in the libgnomeui library. - views. + Since version 2.6, GTK+ provides the GtkAboutDialog widget as a replacement for + the GnomeAbout dialog in the libgnomeui library. - GtkAboutDialog supports all features found in - GnomeAbout. The GtkAboutDialog API is bigger, since it follows the GTK+ policy to - have getters and setters for all widget properties, but it isn't much more complex - than GnomeAbout. + GtkAboutDialog supports all features + found in GnomeAbout. The + GtkAboutDialog API is bigger, since it follows + the GTK+ policy to have getters and setters for all widget properties, + but it isn't much more complex than GnomeAbout. - To convert an application that uses GnomeAbout to GtkAboutDialog, - as a first step, replace calls like + To convert an application that uses GnomeAbout to + GtkAboutDialog, as a first step, replace calls + like const gchar *documentors[] = { "Documenter 1", @@ -60,12 +62,13 @@ - Once you are done with the initial conversion, you may want to look into using some of the - features of GtkAboutDialog which are not present in GnomeAbout. + Once you are done with the initial conversion, you may want to look into + using some of the features of GtkAboutDialog + which are not present in GnomeAbout. - You can specify license information - with the license property + You can specify license information with the + license property You can add separate credits for artists with the @@ -74,11 +77,12 @@ You can add a pointer to the website of your application, using the website and - website-label properties. + website-label + properties. - If your credits contain email addresses or urls, you can turn them into clickable - links using + If your credits contain email addresses or URLs, you can turn them + into clickable links using gtk_about_dialog_set_email_hook() and gtk_about_dialog_set_url_hook(). diff --git a/docs/reference/gtk/migrating-GtkColorButton.sgml b/docs/reference/gtk/migrating-GtkColorButton.sgml index 183b50d005..8bc79c824b 100644 --- a/docs/reference/gtk/migrating-GtkColorButton.sgml +++ b/docs/reference/gtk/migrating-GtkColorButton.sgml @@ -4,14 +4,18 @@ Since version 2.6, GTK+ provides the GtkColorButton - widget as a replacement for the GnomeColorPicker widget in the libgnomeui library. + widget as a replacement for the GnomeColorPicker + widget in the libgnomeui + library. - Porting an application from GnomeColorPicker to GtkColorButton - is very simple. GtkColorButton doesn't support dithering - (since it is rarely needed on modern hardware), and it doesn't have setters and getters to set the - color from floating point or integer components. So instead of + Porting an application from GnomeColorPicker to + GtkColorButton is very simple. + GtkColorButton doesn't support dithering + (since it is rarely needed on modern hardware), and it doesn't have + setters and getters to set the color from floating point or integer + components. So instead of guint red, green, blue, alpha; /* ... */ @@ -21,14 +25,16 @@ GdkColor color; - color.red = red << 8; - color.green = green << 8; - color.blue = blue << 8; - gtk_color_button_set_color (color_picker, &color); - gtk_color_button_set_alpha (color_picker, alpha << 8); + color.red = red << 8; + color.green = green << 8; + color.blue = blue << 8; + gtk_color_button_set_color (color_picker, &color); + gtk_color_button_set_alpha (color_picker, alpha << 8); - and similarly for the setters taking other number formats. For gnome_color_picker_set_i16() no conversion - is needed, for gome_color_picker_set_d(), you need to convert the color components like this: + and similarly for the setters taking other number formats. For + gnome_color_picker_set_i16() no conversion is needed, + for gnome_color_picker_set_d(), you need to convert + the color components like this: color.red = (guint16) (red * 65535.0 + 0.5); color.green = (guint16) (green * 65535.0 + 0.5); diff --git a/docs/reference/gtk/migrating-GtkIconView.sgml b/docs/reference/gtk/migrating-GtkIconView.sgml index 5736fa8dea..bff63ae26d 100644 --- a/docs/reference/gtk/migrating-GtkIconView.sgml +++ b/docs/reference/gtk/migrating-GtkIconView.sgml @@ -3,27 +3,32 @@ Migrating from GnomeIconList to GtkIconView - Since version 2.6, GTK+ provides the GtkIconView - widget. It is similar in functionality to the GnomeIconList widget in the libgnomeui - library, both widgets provide a way to lay out named icons in a grid. The distinctive - feature of the GTK+ widget is that it follows the model-view pattern, allowing - it to share the actual data (i.e. the names and images of the icons) with other - views. + Since version 2.6, GTK+ provides the GtkIconView + widget. It is similar in functionality to the + GnomeIconList widget in the + libgnomeui library, both widgets provide a way to lay out named icons in + a grid. The distinctive feature of the GTK+ widget is that it follows the + model-view pattern, allowing it to share the actual data (i.e. the names + and images of the icons) with other views. - GtkIconView currently doesn't support some features - found in GnomeIconList. Icons can not be positioned freely, the spacing is not customizable, - and it is not possible to edit the names of icons. + GtkIconView currently doesn't support + some features found in GnomeIconList. Icons can + not be positioned freely, the spacing is not customizable, and it is not + possible to edit the names of icons. - To convert an application that uses GnomeIconList to - GtkIconView, the first step is to organize your data - in a GtkTreeModel. GnomeIconList lets you directly - insert data with gnome_icon_list_insert() and gnome_icon_list_insert_pixbuf() and their - append variants. So, if you previously had a function to fill your icon list similar - to this one: + To convert an application that uses GnomeIconList + to GtkIconView, the first step is to + organize your data in a GtkTreeModel. + GnomeIconList lets you directly insert data with + gnome_icon_list_insert() and + gnome_icon_list_insert_pixbuf() and their + append variants. So, if you previously had a function to fill your icon + list similar to this one: void fill_icon_list (GnomeIconList *icon_list) @@ -34,7 +39,8 @@ /* more icons ... */ } - you will have to create a tree model, attach your icon view to it, and fill the model: + you will have to create a tree model, attach your icon view to it, and + fill the model: enum { PIXBUF_COLUMN, @@ -88,15 +94,19 @@ } This example uses a GtkListStore as - model, but part of the elegance of the model-view pattern is that you can easily - use another tree model implementation, or even write your own custom tree model. + model, but part of the elegance of the model-view pattern is that you can + easily use another tree model implementation, or even write your own + custom tree model. Your application may make use of extra data attached to the icons in the - GnomeIconList via gnome_icon_list_set_icon_data() and gnome_icon_list_get_icon_data(). - With GtkIconView such data is most conveniently - stored in an extra column in the tree model, so you would call a function like + GnomeIconList via + gnome_icon_list_set_icon_data() and + gnome_icon_list_get_icon_data(). With + GtkIconView such data is most + conveniently stored in an extra column in the tree model, so you would + call a function like void set_icon_data (GtkIconView *icon_view, @@ -113,20 +123,27 @@ DATA_COLUMN, data, -1); } - assuming that your tree model has a DATA_COLUMN of type G_TYPE_POINTER. + assuming that your tree model has a DATA_COLUMN of type + G_TYPE_POINTER. - There is a number of minor API differences between GnomeIconList and GtkIconView: + There is a number of minor API differences between + GnomeIconList and + GtkIconView: - GnomeIconListMode is replaced by the orientation property of GtkIconView + GnomeIconListMode is replaced by the + orientation + property of GtkIconView - GtkIconView can not be frozen in the same was as GnomeIconList with - gnome_icon_list_freeze() and gnome_icon_list_thaw(). Instead you can - replace the whole model of a GtkIconView, instead of doing many small - changes to the existing model. + GtkIconView can not be frozen in the same + way as GnomeIconList can with + gnome_icon_list_freeze() and + gnome_icon_list_thaw(). Instead you can + replace the whole model of a GtkIconView, + instead of doing many small changes to the existing model. diff --git a/docs/reference/gtk/tmpl/gtkaboutdialog.sgml b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml index d657953d97..ec46584f43 100644 --- a/docs/reference/gtk/tmpl/gtkaboutdialog.sgml +++ b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml @@ -19,7 +19,7 @@ supports this by offering global hooks, which are called when the user clicks on a link or email address, see gtk_about_dialog_set_email_hook() and gtk_about_dialog_set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for -<user@host>, URLs are +<user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break. -- 2.30.2